/**
	Copyright (c) 2009 Ozazo Pvt Ltd, INDIA

	Permission is hereby granted, free of charge, to any person or organization 
	obtaining a copy of this software and associated  documentation  files (the 
	"Software"), to deal in the Software without restriction, including without 
	limitation the rights to use, copy, modify, merge, publish, distribute, sub
	license, and/or sell copies of the Software, and to permit persons  to whom 
	the Software is furnished to do so, subject to the following conditions:
	
	The above copyright notice and  this permission notice shall be included in 
	all copies or substantial portions of the Software.
	
	THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING  BUT NOT  LIMITED  TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR  COPYRIGHT  HOLDERS  BE  LIABLE  FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY,  WHETHER  IN  AN  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
	FROM,  OUT  OF  OR  IN  CONNECTION  WITH  THE  SOFTWARE OR THE USE OR OTHER 
	DEALINGS IN THE SOFTWARE.
 */

package com.ozazo.wave.robots.fw.engines;

import java.util.List;
import java.util.Map;

import com.google.wave.api.Blip;

/**
 * @author Araf Karsh Hamid
 * @version 1.0
 * @seriel 20091121102030
 *
 */
public interface RobotContainerInterface {
	
	/**
	 * Returns the Robot Name
	 * 
	 * @return String
	 */
	
	public String getBotName();
	
	/**
	 * Sets the Robot Name
	 * 
	 * @param String _name
	 */
	
	public void setBotName(String _name);
	
	/**
	 * Sets whether the Robot Engine needs to be processing (the blip) in real time or not.
	 *
	 * @param boolean mode
	 */	
	
	public void setRealTime(boolean _mode);
	
	/**
	 * Sets the Blip Parsing Engine
	 * 
	 * @param _dataParser;
	 */
	
	public void setParsingEngine(BlipDataParserInterface _dataParser);
	
	/**
	 * Sets a collection of engines which can process the blip.
	 * 
	 * @param List<RobotEngineInterface> _engines
	 */
	
	public void setBotEngines(List<RobotEngineInterface> _engines);
	
	/**
	 * This method invokes the Parser to parse the message in real time or after the blip is submitted.
	 * Once the parsing is done it will load the BotEngines to process the commands in the text.
	 * 
	 * 1. Parse the Blip (parse the commands)
	 * 2. Process the commands
	 * 3. Replace the blip with results.
	 * 
	 * @param Blip _blip
	 */
	
	public void processBlip(Blip _blip);	
}
